<!DOCTYPE html>
<html lang="zh_cn">
<head>
          <title>来玩魔王的咚</title>
        <meta name="viewport" content="width=device-width, initial-scale=1" />
        <meta charset="utf-8" />
        <!-- twitter card metadata -->
<meta name="twitter:card" content="summary">
<meta name="twitter:image" content="/images/mowang.png">
<meta name="twitter:site" content="">
<meta name="twitter:title" content="包和工具">
<meta name="twitter:description" content="<p>空导入；包及成员的命名；go工具：工作空间GOPATH，包的下载(go get)，包的构建(go build, go run)，包的文档化(go doc, godoc)，内部包，包的查询(go list)</p>">
        <!-- OG Tags -->
<meta property="og:url" content="/gopl-packages-and-the-go-tool.html"/>
<meta property="og:title" content="来玩魔王的咚 | 包和工具" />
<meta property="og:description" content="<p>空导入；包及成员的命名；go工具：工作空间GOPATH，包的下载(go get)，包的构建(go build, go run)，包的文档化(go doc, godoc)，内部包，包的查询(go list)</p>" />
        <!-- favicon -->
        <link rel="icon" type="image/png" href="/images/mowang.png">
        <!-- moment.js for date formatting -->
        <script src="/theme/js/moment.js"></script>
        <!-- css -->
        <link rel="stylesheet" type="text/css" href="/theme/css/main.css" />
        <!-- 左边的menu，如果页面高度不够，就跟着滚动，否则文章分类显示不全 -->
        <link rel="stylesheet" type="text/css" href="/theme/css/mycss/menu.css" />
		<script>
			
                /*! grunt-grunticon Stylesheet Loader - v2.1.2 | https://github.com/filamentgroup/grunticon | (c) 2015 Scott Jehl, Filament Group, Inc. | MIT license. */
    
    (function(e){function t(t,n,r,o){"use strict";function a(){for(var e,n=0;u.length>n;n++)u[n].href&&u[n].href.indexOf(t)>-1&&(e=!0);e?i.media=r||"all":setTimeout(a)}var i=e.document.createElement("link"),l=n||e.document.getElementsByTagName("script")[0],u=e.document.styleSheets;return i.rel="stylesheet",i.href=t,i.media="only x",i.onload=o||null,l.parentNode.insertBefore(i,l),a(),i}var n=function(r,o){"use strict";if(r&&3===r.length){var a=e.navigator,i=e.Image,l=!(!document.createElementNS||!document.createElementNS("http://www.w3.org/2000/svg","svg").createSVGRect||!document.implementation.hasFeature("http://www.w3.org/TR/SVG11/feature#Image","1.1")||e.opera&&-1===a.userAgent.indexOf("Chrome")||-1!==a.userAgent.indexOf("Series40")),u=new i;u.onerror=function(){n.method="png",n.href=r[2],t(r[2])},u.onload=function(){var e=1===u.width&&1===u.height,a=r[e&&l?0:e?1:2];n.method=e&&l?"svg":e?"datapng":"png",n.href=a,t(a,null,null,o)},u.src="",document.documentElement.className+=" grunticon"}};n.loadCSS=t,e.grunticon=n})(this);(function(e,t){"use strict";var n=t.document,r="grunticon:",o=function(e){if(n.attachEvent?"complete"===n.readyState:"loading"!==n.readyState)e();else{var t=!1;n.addEventListener("readystatechange",function(){t||(t=!0,e())},!1)}},a=function(e){return t.document.querySelector('link[href$="'+e+'"]')},c=function(e){var t,n,o,a,c,i,u={};if(t=e.sheet,!t)return u;n=t.cssRules?t.cssRules:t.rules;for(var l=0;n.length>l;l++)o=n[l].cssText,a=r+n[l].selectorText,c=o.split(");")[0].match(/US\-ASCII\,([^"']+)/),c&&c[1]&&(i=decodeURIComponent(c[1]),u[a]=i);return u},i=function(e){var t,o,a;o="data-grunticon-embed";for(var c in e)if(a=c.slice(r.length),t=n.querySelectorAll(a+"["+o+"]"),t.length)for(var i=0;t.length>i;i++)t[i].innerHTML=e[c],t[i].style.backgroundImage="none",t[i].removeAttribute(o);return t},u=function(t){"svg"===e.method&&o(function(){i(c(a(e.href))),"function"==typeof t&&t()})};e.embedIcons=i,e.getCSS=a,e.getIcons=c,e.ready=o,e.svgLoadedCallback=u,e.embedSVG=u})(grunticon,this);
                
                grunticon(["/theme/css/icons.data.svg.css", "/theme/css/icons.data.png.css", "/theme/css/icons.fallback.css"]);
            </script>
        <noscript><link href="/theme/css/icons.fallback.css" rel="stylesheet"></noscript>
        <!-- menu toggle javascript -->
        <script type="text/javascript">
            document.addEventListener("DOMContentLoaded", initMenu);
            
            function initMenu(){
                var menu = document.getElementById("menu");
                var menulink = document.getElementById("menu-link");
                menulink.addEventListener("click", function toggleMenu(){
                        window.event.preventDefault();
                        menulink.classList.toggle('active');
                        menu.classList.toggle('active');              
                    });
            };
        </script>
        <!-- 不蒜子 -->
        <script async src="//busuanzi.ibruce.info/busuanzi/2.3/busuanzi.pure.mini.js"></script>

    <meta name="description" content="<p>空导入；包及成员的命名；go工具：工作空间GOPATH，包的下载(go get)，包的构建(go build, go run)，包的文档化(go doc, godoc)，内部包，包的查询(go list)</p>" />

    <meta name="tags" content="gopl" />
  <!-- 替换部分base的样式，看文章时，要再宽一点，右边有很多空间可以撑开 -->
  <link rel="stylesheet" type="text/css" href="/theme/css/mycss/article.css" />

</head>
<body>
    <div role="banner" id="masthead">
        <header>
            <a href="/"><img src="/images/mowang.png" alt="McManus Logo"></a>
                <h1>来玩魔王的咚@骑士救兵</h1>
            <a href="#menu" id="menu-link">more stuff</a>
            <nav id="menu">
                <ul>
                        <li><a href="/tags">tags</a></li>
                            <li><a href="/category/cloud.html">Cloud</a></li>
                            <li><a href="/category/docker.html">Docker</a></li>
                            <li class="active"><a href="/category/go.html">Go</a></li>
                            <li><a href="/category/linux.html">Linux</a></li>
                            <li><a href="/category/python.html">Python</a></li>
                            <li><a href="/category/xue-xi-bi-ji.html">学习笔记</a></li>
                            <li><a href="/category/yun-wei-zi-dong-hua.html">运维自动化</a></li>
                </ul>
            </nav>
        </header>
    </div>
        <div class="page" role="main">
  <div class="article" role="article">
    <article>
        <footer>
            <a name="top"></a>
            <p>
              <time datetime=" 2020-08-10 15:00:00+08:00">
                <script>document.write(moment('2020-08-10 15:00:00+08:00').format('LL'));</script>
              </time>
              ~
              <time datetime=" 2020-08-10 15:00:00+08:00">
                <script>document.write(moment('2020-08-10 15:00:00+08:00').format('LL'));</script>
              </time>
            </p>
        </footer>
        <header>
          <h2>
            包和工具
          </h2>
        </header>
      <div class="content">
         <div class="toc">
<ul>
<li><a href="#kong-dao-ru">空导入</a></li>
<li><a href="#ming-ming">命名</a><ul>
<li><a href="#bao-de-ming-ming">包的命名</a></li>
<li><a href="#bao-cheng-yuan-de-ming-ming">包成员的命名</a></li>
</ul>
</li>
<li><a href="#go-gong-ju">go 工具</a><ul>
<li><a href="#gong-zuo-kong-jian-de-zu-zhi">工作空间的组织</a></li>
<li><a href="#bao-de-xia-zai">包的下载</a></li>
<li><a href="#bao-de-gou-jian">包的构建</a></li>
<li><a href="#bao-de-wen-dang-hua">包的文档化</a></li>
<li><a href="#nei-bu-bao">内部包</a></li>
<li><a href="#bao-de-cha-xun">包的查询</a></li>
</ul>
</li>
</ul>
</div>
<h3 id="kong-dao-ru"><a class="toclink" href="#kong-dao-ru">空导入</a></h3>
<p>如果导入包的名字没有在文件中引用，就会产生一个编译错误。但是，有时候必须导入一个包，这仅仅是为了利用它的副作用：对包级别的变量执行初始化表达式求值，并执行它的 init 函数。这里必须使用一个重命名导入，使用下划线作为替代的名字。<br>
这表示导入的内容为空白标识符，通常情况下，空白标识不可能被引用：</p>
<div class="highlight"><pre><span></span><code><span class="kn">import</span><span class="w"> </span><span class="nx">_</span><span class="w"> </span><span class="s">&quot;image/png&quot;</span><span class="w"> </span><span class="c1">// 注册 PNG 解碼器</span><span class="w"></span>
</code></pre></div>

<p><strong>空白导入</strong>，多数情况下，使用空白引用导入额外的包，开启主程序中可选的特性。  </p>
<h3 id="ming-ming"><a class="toclink" href="#ming-ming">命名</a></h3>
<p>一些建议，关于遵从 Go 的习惯来给包和它的成员进行命名。  </p>
<h4 id="bao-de-ming-ming"><a class="toclink" href="#bao-de-ming-ming">包的命名</a></h4>
<p>包名使用简短的名字，但是不要短到完全看不懂。<br>
尽可能保持可读性和无歧义。例如，不要把一个辅助工具包命名为 util，使用 imageutil 或 ioutil 这样更具体和清晰的名字。<br>
避免使用经常用于相关局部变量的名字作为包名，或者迫使使用者使用重命名导入。例如，path 就要避免用作包名。<br>
命名通常使用统一的形式，使用复数形式来避免和关键字的冲突。例如，标准包 bytes、errors、strings。  </p>
<h4 id="bao-cheng-yuan-de-ming-ming"><a class="toclink" href="#bao-cheng-yuan-de-ming-ming">包成员的命名</a></h4>
<p>引用包的成员会带上包名，所以设计成员名称的时候，要考虑包名和成员名这两部分协同一起表示的意义，而不只是成员名。<br>
对于包导出的一个数据类型及其方法，通常有一个 New 函数用来创建实例。而导出的类型的名称可能和包名重复。例如，template.Template 或 rand.Rand。<br>
包中最重要的成员使用最简单的命名。  </p>
<h3 id="go-gong-ju"><a class="toclink" href="#go-gong-ju">go 工具</a></h3>
<p>go 工具将不同种类的工具集合并为一个命名集。它的命令行接口使用“瑞士軍刀”风格，有十几个子命令。<br>
可以运行<code>go help</code>来查看内置文档的索引：</p>
<div class="highlight"><pre><span></span><code>        bug         start a bug report
        build       compile packages and dependencies
        clean       remove object files and cached files
        doc         show documentation for package or symbol
        env         print Go environment information
        fix         update packages to use new APIs
        fmt         gofmt (reformat) package sources
        generate    generate Go files by processing source
        get         download and install packages and dependencies
        install     compile and install packages and dependencies
        list        list packages or modules
        mod         module maintenance
        run         compile and run Go program
        test        test packages
        tool        run specified go tool
        version     print Go version
        vet         report likely mistakes in packages
</code></pre></div>

<h4 id="gong-zuo-kong-jian-de-zu-zhi"><a class="toclink" href="#gong-zuo-kong-jian-de-zu-zhi">工作空间的组织</a></h4>
<p>环境变量 GOPATH 执行工作空间的根。当需要切换不同的工作空间时，更新 GOPATH 变量即可。<br>
切换环境变量然后下载代码：</p>
<div class="highlight"><pre><span></span><code>$ <span class="nb">export</span> <span class="nv">GOPATH</span><span class="o">=</span><span class="nv">$HOME</span>/gobook
$ go get gopl.io/...
</code></pre></div>

<p><em>命令最后的三个点的意义，go get 命令下一节会讲。</em>  </p>
<p>GOPATH 有三个子目录，分别用于存放不同类型的文件：</p>
<ul>
<li>src：源码文件。每一个包在一个目录中</li>
<li>pkg：归档文件。构建工具存储编译后的包的位置，参考后面的 go install 命令</li>
<li>bin：可执行文件。许多用户会将该目录添加到可执行程序的搜索列表中</li>
</ul>
<p>环境变量 GOROOT 指定 Go 发行版的根目录，其中提供所有标准库的包。用户无须设置 GOROOT，因为默认情况下在安装 Go 言语的时候会将其设置为安装路径。（<em>如果机器上装了多个版本的Go，就可以通过这个环境变量来切换了吧。不过Go目前需要使用多个版本的问题。</em>）  </p>
<p>命令 go env 可以查看环境变量。  </p>
<h4 id="bao-de-xia-zai"><a class="toclink" href="#bao-de-xia-zai">包的下载</a></h4>
<p>go get 命令可以下载单一的包，也可以使用 ... 符号来下载子目录或仓库。并且还会计算并下载所有依赖的包。  </p>
<p>让包使用一个自定义的导入路径，但是真实的代码却是由更通用的站点提供，例如 github。这只需要在页面的 HTML 中添加如下的元数据，它重定向 go 工具到实际托管地址的 Git 仓库：</p>
<div class="highlight"><pre><span></span><code><span class="p">&lt;</span><span class="nt">meta</span> <span class="na">name</span><span class="o">=</span><span class="s">&quot;go-import&quot;</span> <span class="na">content</span><span class="o">=</span><span class="s">&quot;golang.org/x/net git https://go.googlesource.com/net&quot;</span><span class="p">&gt;</span>
</code></pre></div>

<p>go get 指定 -u 参数，将确保命令会访问所有的包（无论本地是否已经有了）更新到最新版本。如果没有这个参数，已经存在在本地的包就做任何处理和确认。  </p>
<h4 id="bao-de-gou-jian"><a class="toclink" href="#bao-de-gou-jian">包的构建</a></h4>
<p>命令 go build 编译每一个命令行参数中的包。如果包是一个库，结果会被丢弃。如果是main包，则会创建可执行程序。<br>
命令 go run 则可以构建之后直接运行。适用于即用即抛型的程序。<br>
第一个不是以 .go 结尾的参数会作为 Go 可执行程序的参数列表的开始。  </p>
<p>默认情况下，go build 命令构建所有需要的包以及它们所有的依赖，然后丢弃除了最终可执行程序之外的所有编译后的代码。<br>
命令 go install 和 go build 非常相似，区别是它会保存每一个包的编译代码和命令，而不丢弃。编译后的包保存在 $GOPATH/pkg 目录中。这样，之后的 go build 和 go install 对于没有改变的包和命令不需要再重新编译，从而使后续的构建更快完成。<br>
go build 使用 -i 参数，也会安装那些编译目标依赖的且还未被安装的代码包。同样是安装到 pkg 目录。  </p>
<h4 id="bao-de-wen-dang-hua"><a class="toclink" href="#bao-de-wen-dang-hua">包的文档化</a></h4>
<p>每一个导出的包成员的声明以及包声明自身应该使用文档注释来描述它的目的和用途。Go 文档注释总是完整的语句，第一行通常是摘要说明，以被注释者的名称（比如函数名）开头。<br>
包声明的前面的文档注释是对整个包进行描述。它可以出现在任何一个文件里，但是每一个包里值能在一个文件开头写包的文档注释。比较长的包注释可以使用一个单独的注释文件，文件名通常叫 doc.go。  </p>
<h5 id="go-doc"><a class="toclink" href="#go-doc">go doc</a></h5>
<p>go doc 工具输出在命令行上指定的内容的声明和整个文档注释，可以是一个包、一个包成员、一个方法。  </p>
<h5 id="godoc"><a class="toclink" href="#godoc">godoc</a></h5>
<p>这是另一个工具，它提供一个 HTML 页面，展示的内容不少于 go doc 命令。<br>
如果想浏览自己的包，可以在自己的工作区目录中运行 godoc。在执行下面的命令后，在浏览器中访问 <code>http://localhost:8000/pkg</code> ：</p>
<div class="highlight"><pre><span></span><code>$ godoc -http :8000
</code></pre></div>

<p>还可以使用 -analysis=type 和 -analysis=pointer 命令行标志参数，用于打开文档和代码中关于静态分析的结果。  </p>
<h4 id="nei-bu-bao"><a class="toclink" href="#nei-bu-bao">内部包</a></h4>
<p>导入路径中包含 internal 的情况，会被特殊对待。这种包叫<strong>内部包</strong>，内部包只能被特定范围内的包导入，就是以这个内部包的父目录为根的目录树中的其他的包。  </p>
<h4 id="bao-de-cha-xun"><a class="toclink" href="#bao-de-cha-xun">包的查询</a></h4>
<p>go list 工具上报可用包的信息。通过简单的形式，go list 判断一个包是否存在于工作区目录中，如果存在就输出它的导入路径：</p>
<div class="highlight"><pre><span></span><code>PS H:\Go\src\gopl\ch10&gt; go list gopl/ch9/bank1
gopl/ch9/bank1
</code></pre></div>

<p>go list 命令的参数可以包含 “...” 通配符（类似于通配符星号的作用），用来匹配包的导入路径中的任意字符串。这可以枚举当前工作区目录下的所有的包： <code>go list ...</code> ，输出的结果实在太多了。<br>
下面是一个指定的目录中的所有的包：</p>
<div class="highlight"><pre><span></span><code>PS H:\Go\src\gopl\ch10&gt; go list gopl/ch9/...
gopl/ch9/bank1
gopl/ch9/bank2
gopl/ch9/bank3
gopl/ch9/hacker
</code></pre></div>

<p>下面则是查找某个主题：</p>
<div class="highlight"><pre><span></span><code>PS H:\Go\src\gopl\ch10&gt; go list ...netcat...
gopl/ch8/netcat1
gopl/ch8/netcat2
gopl/ch8/netcat3
gopl/exercise8/e8/netcat
</code></pre></div>

<p>这里匹配的并不是包名，而是包的整个导入路径。这也包括从工作区目录为根开始的路径所组成的字符串里的任何内容。  </p>
<p>go list 命令获取每一个包的完整元数据，而不仅仅是导入路径，并且提供各种对于用户或者其他工具可访问的格式。  </p>
<p>-json 标记使 go list 以 JSON 格式输出每一个包的完整记录：</p>
<div class="highlight"><pre><span></span><code>PS H:\Go\src\gopl\ch10&gt; go list -json gopl/ch9/bank1
{
        &quot;Dir&quot;: &quot;H:\\Go\\src\\gopl\\ch9\\bank1&quot;,
        &quot;ImportPath&quot;: &quot;gopl/ch9/bank1&quot;,
        &quot;Name&quot;: &quot;bank&quot;,
        &quot;Doc&quot;: &quot;这是一个只有一个账户的并发安全银行&quot;,
        &quot;Target&quot;: &quot;H:\\Go\\pkg\\windows_amd64\\gopl\\ch9\\bank1.a&quot;,
        &quot;Root&quot;: &quot;H:\\Go\\&quot;,
        &quot;Match&quot;: [
                &quot;gopl/ch9/bank1&quot;
        ],
        &quot;Stale&quot;: true,
        &quot;StaleReason&quot;: &quot;build ID mismatch&quot;,
        &quot;GoFiles&quot;: [
                &quot;main.go&quot;
        ]
}
</code></pre></div>

<p>这里展开介绍其中三个字段的意义：</p>
<ol>
<li>GoFiles ：库源码文件或命令源码文件，就是实际保存产品代码的文件列表</li>
<li>TestGoFiles ：测试源码文件，都是以以 _test.go 结尾的文件，仅在编译测试的时候才会使用</li>
<li>XTestGoFiles ：外部测试包。也是测试源码文件，也是 _test.go 结尾，也是在测试过程中使用的。下篇的测试章节会讲到</li>
</ol>
<p>-f 标记可以让用户通过 text/temple 包提供的模板语言来定制输出的格式：</p>
<div class="highlight"><pre><span></span><code>PS H:\Go\src\gopl\ch10&gt; go list -json strconv
{
...
        &quot;Deps&quot;: [
                &quot;errors&quot;,
                &quot;internal/cpu&quot;,
                &quot;math&quot;,
                &quot;math/bits&quot;,
                &quot;unicode/utf8&quot;,
                &quot;unsafe&quot;
        ],
...
}

PS H:\Go\src\gopl\ch10&gt; go list -f &quot;{{join .Deps \&quot;&quot; \&quot;&quot;}}&quot; strconv
errors internal/cpu math math/bits unicode/utf8 unsafe
PS H:\Go\src\gopl\ch10&gt; go list -f &#39;{{join .Deps \&quot; \&quot;}}&#39; strconv
errors internal/cpu math math/bits unicode/utf8 unsafe
PS H:\Go\src\gopl\ch10&gt; go list -f &quot;{{join .Deps `` ``}}&quot; strconv
errors internal/cpu math math/bits unicode/utf8 unsafe
PS H:\Go\src\gopl\ch10&gt; go list -f &#39;{{join .Deps ` `}}&#39; strconv
errors internal/cpu math math/bits unicode/utf8 unsafe
</code></pre></div>

<p>由于这里 -f 的参数中有空格，必须要用引号包起来。而参数的内容中还包含引号，所以这个参数很难写。<br>
这里只给出几个示例，具体什么规则讲不清楚，大概有下面几点：</p>
<ul>
<li>首先，这个windows的环境。Linux下没有这么坑</li>
<li>双引号内部的特殊符号，需要重复写两遍，两个双引号表示一个双引号</li>
<li>单引号内部的特殊符号，不用重复写两遍</li>
<li>双引号前面要转义，所以在前面要加上斜杠（\）</li>
<li>最后两个命令，内层用的是撇号（`），所以不要加斜杠转义</li>
</ul>
<p>下面的命令输出标准库的 compress 子树中每个包的直接导入记录：</p>
<div class="highlight"><pre><span></span><code>PS H:\Go\src\gopl\ch10&gt; go list compress/...
compress/bzip2
compress/flate
compress/gzip
compress/lzw
compress/zlib

PS H:\Go\src\gopl\ch10&gt; go list -f &quot;{{.ImportPath}} -&gt; {{join .Imports \&quot;&quot; \&quot;&quot;}}&quot; compress/...
compress/bzip2 -&gt; bufio io sort
compress/flate -&gt; bufio fmt io math math/bits sort strconv sync
compress/gzip -&gt; bufio compress/flate encoding/binary errors fmt hash/crc32 io time
compress/lzw -&gt; bufio errors fmt io
compress/zlib -&gt; bufio compress/flate errors fmt hash hash/adler32 io
</code></pre></div>

<p>go list 命令对于一次性的交互查询和构建、测试脚本都非常有用。更多的参数信息，可以通过 go help list 来获取。  </p>
      </div>
      <div class="back-to-top">
        <a href="/">HOME</a>
        <a href="#top">TOP</a>
      </div>
    </article>
  </div>
<!-- end article -->
<!-- 页面往下滚动一段之后才会显示TOC -->
<script>
  window.onscroll = function() {
    var tocbox = document.getElementsByClassName('toc')[0];
    var osTop = document.documentElement.scrollTop || document.body.scrollTop;
    var osWidth = document.documentElement.scrollWidth || document.body.scrollWidth;
    // console.log(osTop)
    if (osTop>300 && osWidth>865) {
      tocbox.style.display = "block"
    }
    if (osTop<300 || osWidth<865) {
      tocbox.style.display = "none"
    }
  }
</script>
                <footer>
                    <div class="icons">
                    </div>
                    <span id="busuanzi_container_page_pv" style="padding: 10px">本文阅读量<span id="busuanzi_value_page_pv"></span>次</span>
                    <span id="busuanzi_container_site_pv" style="padding: 10px">本站总访问量<span id="busuanzi_value_site_pv"></span>次</span>
                    <span id="busuanzi_container_site_uv" style="padding: 10px">本站总访客数<span id="busuanzi_value_site_uv"></span>人</span>
                    <p>© <script>document.write(moment().format('YYYY'));</script> 749B</p>
                </footer>
        </div>
</body>
</html>